home *** CD-ROM | disk | FTP | other *** search
/ Floppyshop 2 / Floppyshop - 2.zip / Floppyshop - 2.iso / art&graf.ix / art-0072 / animtool / animtool.doc < prev    next >
Text File  |  1997-04-16  |  10KB  |  211 lines
  1. -------------------------------------------------------------------------
  2. | ANIMTOOL is copyright (c) 1991 by Martin Packer. All rights reserved. |
  3. |                                                                       |
  4. | Permission is granted for unrestriced non-commercial use and          |
  5. | distribution by individuals, public domain libraries and BBS's.       |
  6. | With the condition that it must be accompanied by this file.          |
  7. |                                                                       |
  8. | If you find any bugs, have any suggestions for improvements, feel     |
  9. | the urge to send me large quantities of money, or just want to say    |
  10. | hi! Please write to me:                                               |
  11. |                                                                       |
  12. |         Martin Packer                                                 |
  13. |         81B Preston Road                                              |
  14. |         Brighton                                                      |
  15. |         East Sussex                                                   |
  16. |         U.K.                                                          |
  17. -------------------------------------------------------------------------
  18. ANIMTOOL is a utility for stringing a sequence of low-res image files
  19. together into an animation. It uses delta compression (only storing the
  20. differences between frames) to reduce the size and increase the playback
  21. speed of the animation files it generates.
  22.  
  23. The original command line version of ANIMTOOL came about because I wanted
  24. to animate some scenes I'd generated using David Buck's DKBTrace Ray-
  25. Tracer.
  26.  
  27. There are two versions of ANIMTOOL:
  28.  
  29. ANIMTOOL.PRG
  30. Is a version with a nice GEM front-end which allows animations to be
  31. loaded, played, manipulated in memory and saved.
  32.  
  33. ANIMTOOL.TTP
  34. Is a single pass command line version which can play an animation or
  35. carry out one of the manipulation operations. Because it only carries out
  36. one operation at a time (and because the program itself is quite a lot
  37. smaller), it uses a lot less memory than the GEM version, so it can be
  38. used to build and play larger animations if memory is getting tight. This
  39. version can also be renamed ANIMTOOL.PRG and placed in an auto folder,
  40. where it will attempt to load and play the animation SEQUENCE.TAT in the
  41. root directory of the boot disk.
  42.  
  43.  
  44.                A Quick Guide to the Features of ANIMTOOL:
  45.  
  46. ANIMTOOL.PRG is controlled from a single full screen dialogue. Here's
  47. what the various bits mean:
  48.  
  49. Current Animation:
  50.  
  51.      Filename:           The name of the current animation. The default
  52.                          animation file is SEQUENCE.TAT. When you run
  53.                          ANIMTOOL this file will be loaded if it exists.
  54.  
  55.      Number of Frames:   The total number of frames in the animation.
  56.  
  57.      Default Speed:      When you load a new animation into ANIMTOOL.PRG,
  58.                          the playback speed will be set to the
  59.                          animation's default value. This is also the
  60.                          speed it will normally run at when played by
  61.                          ANIMTOOL.TTP.
  62.  
  63.      Repeat:             Animations can be set to repeat indefinitely
  64.                          when played. This is the default setting which
  65.                          works in the same way as the default speed.
  66.  
  67.      Load:               Click here to load an animation. If you want to
  68.                          create a new animation, click here and type the
  69.                          name into the file selector.
  70.  
  71.      Save:               Click here to save the current animation.
  72.  
  73.      Save As:            Click here to save the current animation with a
  74.                          different file name.
  75.  
  76.  
  77. Workspace:
  78.  
  79.      When you run ANIMTOOL it will grab the largest chunk of memory it
  80.      can find to use as its workspace. This tells you how many bytes
  81.      you've used and how much you've got left.
  82.  
  83.  
  84. Show Frame Info:
  85.  
  86.      A "frame" is actually the stored differences between one screen
  87.      image in the animation and the next. A frame consists of one or two
  88.      records. If the two screen palettes differ, the frame will contain a
  89.      palette record. If the screen images are similar, with no large-
  90.      scale differences, then the frame will contain a delta record, which
  91.      contains only the differences between the images. If the screen
  92.      images are too dissimilar for a delta record to be worthwhile, the
  93.      frame will contain a screen dump record, which contains all 32000
  94.      bytes of the new screen image. By entering a frame number here, or
  95.      selecting it using the + and - buttons, and clicking on "Show Frame
  96.      Info" you can find out which records are present in a frame and how
  97.      many bytes the frame occupies.
  98.  
  99.  
  100. Play Animation:
  101.  
  102.      Clicking here plays the current animation. Press escape at any time
  103.      to stop.
  104.  
  105.      Speed:              Selects the playback speed of the animation. The
  106.                          number here indicates how long each image in the
  107.                          animation will be displayed for, in VBL's
  108.                          (vertical blanks - the time taken for the
  109.                          television/monitor display to be refreshed - on
  110.                          UK systems, one VBL is 1/50th of a second). With
  111.                          a complicated animation (where the delta frames
  112.                          are larger than about 12K) it may not be
  113.                          possible to play the animation at maximum speed
  114.                          (1 VBL/frame). It's possible to get an idea of
  115.                          the maximum playing speed for an animation by
  116.                          setting the speed to 0. If you do this the
  117.                          animation will be played at maximum possible
  118.                          speed without it being sychronised with the
  119.                          screen refresh. The currently set speed will be
  120.                          saved as the default speed when you save an
  121.                          animation.
  122.  
  123.      To Frame:           If a number is entered here the animation will
  124.                          only play up to the frame indicated. In
  125.                          combination with "Pause" this lets you isolate
  126.                          and view a single frame.
  127.  
  128.      Repeat:             If "Yes" is selected the animation will repeat
  129.                          indefinitely when played. This feature should
  130.                          only be used if the first frame of the animation
  131.                          contains a dump record (it usually does). If it
  132.                          doesn't, strange things will happen because the
  133.                          animation routines assume that the screen starts
  134.                          off cleared to colour 0 and the first frame (if
  135.                          it contains a delta record) will depend on this.
  136.                          The current repeat state will be saved as the
  137.                          default when you save an animation.
  138.  
  139.      Pause:              If "Yes" is selected, after playing an
  140.                          animation, the computer will wait for a keypress
  141.                          before returning to the control screen.
  142.  
  143.      Step:               If "Yes" is selected, the computer will wait for
  144.                          a keypress between each frame of the animation.
  145.  
  146.  
  147. Add Degas Image Frame:
  148.  
  149.      Click here to add the indicated degas image to the animation.
  150.  
  151.      FileName:           Click here and select the file containing the
  152.                          image you want to append to your animation.
  153.  
  154.      Dump Frame:         When "Add Degas Image Frame" is selected,
  155.                          ANIMTOOL will usually try to generate a delta
  156.                          record for the new image. You can force a screen
  157.                          dump record to be generated by selecting this
  158.                          button.
  159.  
  160.  
  161. Add Loop Frame:
  162.  
  163.      Usually the animation will progress in sequence from one image to
  164.      the next. This feature allows you to build loops into your
  165.      animation. Loop frames can be used to repeat short sequences, repeat
  166.      the whole animation or repeat (effectively pause on) a single frame.
  167.      A loop frame is the same as any other frame. A delta (or screen
  168.      dump) record and possibly a palette record must be generated holding
  169.      the differences between the current last image in the animation and
  170.      the one you're looping to. Animation loops can be 'nested' inside
  171.      one another to any depth. The "dump frame" button has the same
  172.      effect when adding loop frames as with image frames.
  173.  
  174.      Loop To:            Select the frame you wan't to loop back to here.
  175.  
  176.      Loop Count:         Select the number of times the animation should
  177.                          loop back before continuing. This number should
  178.                          be one less than the number of times you want
  179.                          the loop repeated (it will have played once
  180.                          already). If you enter a count of 0 the looping
  181.                          will continue indefinitely.
  182.  
  183.  
  184. Delete Last Frame:
  185.  
  186.      Clicking here removes the last frame from the animation.
  187.  
  188.  
  189.  
  190. ANIMTOOL.TTP can do everything that ANIMTOOL.PRG can except deleting the
  191. last frame. As mentioned earlier, it uses less memory than ANIMTOOL.PRG
  192. but it can only carry out one operation per pass. So it's a pretty slow
  193. way to do things if you're loading the animation from a floppy disk each
  194. time. I usually write a CLI batch file which uses ANIMTOOL.TTP to build
  195. my animations.
  196.  
  197. Usage: ANIMTOOL <filename> <options>
  198.  
  199. Options:
  200.  
  201.      /H              Display help screen.
  202.      /I<filename>    Degas (PI1) image to append.
  203.      /S<speed>       Playback speed (VBLs/frame).
  204.      +/-R            Repeat/don't repeat animation.
  205.      /L<frame no.>   Append a loop back to this frame
  206.      /C<count>       Used with /L to define the loop count
  207.      /D              Force new frame to be a screen dump
  208.  
  209. If filename is not given the default SEQUENCE.TAT is used.
  210.  
  211.